<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.18"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>aws-crt-cpp: Aws::Iot::MqttClientConnectionConfig Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">aws-crt-cpp
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.18 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="namespaceAws.html">Aws</a></li><li class="navelem"><a class="el" href="namespaceAws_1_1Iot.html">Iot</a></li><li class="navelem"><a class="el" href="classAws_1_1Iot_1_1MqttClientConnectionConfig.html">MqttClientConnectionConfig</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="#friends">Friends</a> &#124;
<a href="classAws_1_1Iot_1_1MqttClientConnectionConfig-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">Aws::Iot::MqttClientConnectionConfig Class Reference<span class="mlabels"><span class="mlabel">final</span></span></div>  </div>
</div><!--header-->
<div class="contents">

<p><code>#include &lt;<a class="el" href="iot_2MqttClient_8h_source.html">MqttClient.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a8d7b36212b7ae6b550ff66e89d1a0998"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAws_1_1Iot_1_1MqttClientConnectionConfig.html#a8d7b36212b7ae6b550ff66e89d1a0998">MqttClientConnectionConfig</a> (const <a class="el" href="namespaceAws_1_1Crt.html#a865381ab2bc5db45524fa6ce43c394c3">Crt::String</a> &amp;endpoint, uint16_t port, const <a class="el" href="classAws_1_1Crt_1_1Io_1_1SocketOptions.html">Crt::Io::SocketOptions</a> &amp;socketOptions, <a class="el" href="classAws_1_1Crt_1_1Io_1_1TlsContext.html">Crt::Io::TlsContext</a> &amp;&amp;tlsContext)</td></tr>
<tr class="separator:a8d7b36212b7ae6b550ff66e89d1a0998"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a875e278c766dc649fb633548bea269b5"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAws_1_1Iot_1_1MqttClientConnectionConfig.html#a875e278c766dc649fb633548bea269b5">MqttClientConnectionConfig</a> (const <a class="el" href="namespaceAws_1_1Crt.html#a865381ab2bc5db45524fa6ce43c394c3">Crt::String</a> &amp;endpoint, uint16_t port, const <a class="el" href="classAws_1_1Crt_1_1Io_1_1SocketOptions.html">Crt::Io::SocketOptions</a> &amp;socketOptions, <a class="el" href="classAws_1_1Crt_1_1Io_1_1TlsContext.html">Crt::Io::TlsContext</a> &amp;&amp;tlsContext, <a class="el" href="namespaceAws_1_1Crt_1_1Mqtt.html#a164f0b4ae6ab32eae4125e685349a8d1">Crt::Mqtt::OnWebSocketHandshakeIntercept</a> &amp;&amp;interceptor, const <a class="el" href="classAws_1_1Crt_1_1Optional.html">Crt::Optional</a>&lt; <a class="el" href="classAws_1_1Crt_1_1Http_1_1HttpClientConnectionProxyOptions.html">Crt::Http::HttpClientConnectionProxyOptions</a> &gt; &amp;proxyOptions)</td></tr>
<tr class="separator:a875e278c766dc649fb633548bea269b5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae48f40de769feebf3b78d316c0729719"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAws_1_1Iot_1_1MqttClientConnectionConfig.html#ae48f40de769feebf3b78d316c0729719">operator bool</a> () const noexcept</td></tr>
<tr class="separator:ae48f40de769feebf3b78d316c0729719"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aebdc5d38cb40d62222d072629b1430aa"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAws_1_1Iot_1_1MqttClientConnectionConfig.html#aebdc5d38cb40d62222d072629b1430aa">LastError</a> () const noexcept</td></tr>
<tr class="separator:aebdc5d38cb40d62222d072629b1430aa"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:a25947708a6c5bc7eaf8736a1022c49ea"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classAws_1_1Iot_1_1MqttClientConnectionConfig.html">MqttClientConnectionConfig</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAws_1_1Iot_1_1MqttClientConnectionConfig.html#a25947708a6c5bc7eaf8736a1022c49ea">CreateInvalid</a> (int lastError) noexcept</td></tr>
<tr class="separator:a25947708a6c5bc7eaf8736a1022c49ea"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a>
Friends</h2></td></tr>
<tr class="memitem:a85a96c1d928c2dbdd7e09a1def5d4a8e"><td class="memItemLeft" align="right" valign="top">class&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAws_1_1Iot_1_1MqttClientConnectionConfig.html#a85a96c1d928c2dbdd7e09a1def5d4a8e">MqttClient</a></td></tr>
<tr class="separator:a85a96c1d928c2dbdd7e09a1def5d4a8e"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Represents a unique configuration for connecting to a single endpoint. You can use a single instance of this class PER endpoint you want to connect to. This object must live through the lifetime of your connection. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a8d7b36212b7ae6b550ff66e89d1a0998"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8d7b36212b7ae6b550ff66e89d1a0998">&#9670;&nbsp;</a></span>MqttClientConnectionConfig() <span class="overload">[1/2]</span></h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">Aws::Iot::MqttClientConnectionConfig::MqttClientConnectionConfig </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="namespaceAws_1_1Crt.html#a865381ab2bc5db45524fa6ce43c394c3">Crt::String</a> &amp;&#160;</td>
          <td class="paramname"><em>endpoint</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint16_t&#160;</td>
          <td class="paramname"><em>port</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="classAws_1_1Crt_1_1Io_1_1SocketOptions.html">Crt::Io::SocketOptions</a> &amp;&#160;</td>
          <td class="paramname"><em>socketOptions</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="classAws_1_1Crt_1_1Io_1_1TlsContext.html">Crt::Io::TlsContext</a> &amp;&amp;&#160;</td>
          <td class="paramname"><em>tlsContext</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Creates a client configuration for use with making new AWS <a class="el" href="namespaceAws_1_1Iot.html">Iot</a> specific MQTT Connections with MTLS. </p>

</div>
</div>
<a id="a875e278c766dc649fb633548bea269b5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a875e278c766dc649fb633548bea269b5">&#9670;&nbsp;</a></span>MqttClientConnectionConfig() <span class="overload">[2/2]</span></h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">Aws::Iot::MqttClientConnectionConfig::MqttClientConnectionConfig </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="namespaceAws_1_1Crt.html#a865381ab2bc5db45524fa6ce43c394c3">Crt::String</a> &amp;&#160;</td>
          <td class="paramname"><em>endpoint</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint16_t&#160;</td>
          <td class="paramname"><em>port</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="classAws_1_1Crt_1_1Io_1_1SocketOptions.html">Crt::Io::SocketOptions</a> &amp;&#160;</td>
          <td class="paramname"><em>socketOptions</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="classAws_1_1Crt_1_1Io_1_1TlsContext.html">Crt::Io::TlsContext</a> &amp;&amp;&#160;</td>
          <td class="paramname"><em>tlsContext</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="namespaceAws_1_1Crt_1_1Mqtt.html#a164f0b4ae6ab32eae4125e685349a8d1">Crt::Mqtt::OnWebSocketHandshakeIntercept</a> &amp;&amp;&#160;</td>
          <td class="paramname"><em>interceptor</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="classAws_1_1Crt_1_1Optional.html">Crt::Optional</a>&lt; <a class="el" href="classAws_1_1Crt_1_1Http_1_1HttpClientConnectionProxyOptions.html">Crt::Http::HttpClientConnectionProxyOptions</a> &gt; &amp;&#160;</td>
          <td class="paramname"><em>proxyOptions</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Creates a client configuration for use with making new AWS <a class="el" href="namespaceAws_1_1Iot.html">Iot</a> specific MQTT Connections with web sockets. interceptor: a callback invoked during web socket handshake giving you the opportunity to mutate the request for authorization/signing purposes. If not specified, it's assumed you don't need to sign the request. proxyOptions: optional, if you want to use a proxy with websockets, specify the configuration options here.</p>
<p>If proxy options are used, the tlsContext is applied to the connection to the remote endpoint, NOT the proxy. To make a tls connection to the proxy itself, you'll want to specify tls options in proxyOptions. </p>

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a25947708a6c5bc7eaf8736a1022c49ea"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a25947708a6c5bc7eaf8736a1022c49ea">&#9670;&nbsp;</a></span>CreateInvalid()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classAws_1_1Iot_1_1MqttClientConnectionConfig.html">MqttClientConnectionConfig</a> Aws::Iot::MqttClientConnectionConfig::CreateInvalid </td>
          <td>(</td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>lastError</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span><span class="mlabel">noexcept</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

</div>
</div>
<a id="aebdc5d38cb40d62222d072629b1430aa"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aebdc5d38cb40d62222d072629b1430aa">&#9670;&nbsp;</a></span>LastError()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">int Aws::Iot::MqttClientConnectionConfig::LastError </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>the value of the last aws error encountered by operations on this instance. </dd></dl>

</div>
</div>
<a id="ae48f40de769feebf3b78d316c0729719"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae48f40de769feebf3b78d316c0729719">&#9670;&nbsp;</a></span>operator bool()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">Aws::Iot::MqttClientConnectionConfig::operator bool </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">explicit</span><span class="mlabel">noexcept</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>true if the instance is in a valid state, false otherwise. </dd></dl>

</div>
</div>
<h2 class="groupheader">Friends And Related Function Documentation</h2>
<a id="a85a96c1d928c2dbdd7e09a1def5d4a8e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a85a96c1d928c2dbdd7e09a1def5d4a8e">&#9670;&nbsp;</a></span>MqttClient</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">friend class <a class="el" href="classAws_1_1Iot_1_1MqttClient.html">MqttClient</a></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">friend</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>/home/ANT.AMAZON.COM/dengket/doc/aws-crt-cpp/include/aws/iot/<a class="el" href="iot_2MqttClient_8h_source.html">MqttClient.h</a></li>
<li>/home/ANT.AMAZON.COM/dengket/doc/aws-crt-cpp/source/iot/<a class="el" href="iot_2MqttClient_8cpp.html">MqttClient.cpp</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.18
</small></address>
</body>
</html>
